Skip to content

Sync dev to main: page descriptions - #1103

Merged
bharvey88 merged 2 commits into
mainfrom
dev
Aug 22, 2026
Merged

Sync dev to main: page descriptions#1103
bharvey88 merged 2 commits into
mainfrom
dev

Conversation

@bharvey88

Copy link
Copy Markdown
Contributor

Publishes #1102 to the live wiki.

* Stop publishing snippet fragments, and two small fixes

The 25 files under docs/_snippets are fragments that other pages pull in
via pymdownx.snippets. They were also building as standalone pages, so
they sat in the sitemap for Google to index and generated their own social
cards. One of them is a bare admonition with two buttons, presented to a
reader as a page. Exclude the directory from the build output. The
snippets extension reads these from disk through its own base_path rather
than through MkDocs' file collection, so every include still resolves.

Point the PLT-1B links in the two sensor connection check pages at the
plt1b pages. Both files label the links "PLT-1B reset button" and "PLT-1B
boot button" while pointing at plt1 paths, and both already use temp1b
paths for their TEMP-1B labels, so the -B variants are what these want.

Fix three spellings of "rechargable".

Verified with a full build: no _snippets page is emitted, the sitemap
carries zero _snippets entries, and all 49 pages that include a fragment
render its content with no raw snippet syntax leaking through.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

* Give every page its own description

Every publishable page now carries its own description, so no page falls
back to the site-wide sentence in a link embed or a search result. 688
pages, previously 303 of them had nothing of their own.

Most of this is not new prose. 178 of the pages are snippet wrappers whose
entire content is one include line, and they inherit the description of
the page they mirror, following the chain where one wrapper includes
another. Another 68 homey pages inherit from their main tree counterpart,
skipping any whose description names Home Assistant or ESPHome, since
those would be wrong on a Homey page. That left 59 written from the page
content: 28 in the main tree and 31 under homey.

Every description is quoted. An unquoted YAML scalar containing a colon
followed by a space parses as a mapping, which silently invalidates the
front matter and leaves the page on the fallback with no build warning.

Ten pages are included elsewhere whole, so their includers get a line
offset to skip the new front matter. Without it the front matter renders
as visible text on the including page.

Five includes pointed at files that do not exist, so those pages were live
and rendering empty. Three are repaired: the homey AIR-1 prevent sleep
page now pulls the general battery sensor page rather than a path that was
never there, the homey zone configuration page matches its main tree
equivalent, and the Odroid Bluetooth tracking page was missing the
products/ prefix. The other two, products/msr1/calibrating-co2 and
homey/products/mtr1/calibrating-co2, are removed. Both pulled a
co2-calibration-quick-mobile page that has never existed, neither is in
the nav, and both products already have a working CO2 calibration page.

The homey Our Team page pulled contact-us/general/our-team, another path
that does not exist, and rendered as a bare title. It now pulls the real
page.

Verified against a full build: no page emits the site-wide fallback, no
page leaks raw front matter or raw snippet syntax into its body, the
previously empty pages render their content, and the sitemap holds 688
URLs with the two removed pages gone.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@coderabbitai

coderabbitai Bot commented Aug 22, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)
  • beta

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c8984eb5-1d95-4acb-bb38-d393e61aeb71

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@bharvey88
bharvey88 merged commit 28f15ff into main Aug 22, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant